home *** CD-ROM | disk | FTP | other *** search
/ Hyper Stacks 1994 May / Hyper Stacks (Pacific HiTech)(1994)[Mac].iso / Organization / HyperWais / README < prev    next >
Text File  |  1992-10-04  |  5KB  |  93 lines

  1. HyperWais 1.4:
  2. -------------
  3.  
  4. Welcome to HyperWais, a Hypercard stack for searching WAIS
  5. (Wide Area Information Servers).
  6.  
  7. Packing list:
  8.  
  9. After you have uncompressed the archive, you should find:
  10. - This file (README).
  11.  
  12. - The copyright file (COPYRIGHT).
  13.  
  14. - A Hypercard stack called HyperWais, which is a sample stack for searching WAIS databases. This stack contains a set of XCMDs which allow the stack to communicate (via Apple Events) with the "Wais Listener". There is also another stacks called HyperWais 12
  15. for 12" monitors.
  16.  
  17. - A application called "Wais Listener", this is the Faceless Background Application (FBA) which allows the Hypercard stack to communicate with WAIS servers. This application just sits in the background and listens out to Apple Events. All you need to do is start it up. Note that the wais-listener will grab a chunk of memory (about 450K) which will be added to the system software in the "About this mac" box.
  18.  
  19. - Another application called "Wais Listener.debug", this is the same application as the Wais Listener but will have a visible debug window which will list out all the events/data received and events/data returned. You may want to use this application to see what is going on. Both "Wais Listener" and "Wais Listener.debug" create log files which can be looked at with any text editor.
  20.  
  21. - A folder called wais-sources where HyperWais stores the WAIS source description files. 
  22.  
  23. - A folder called wais-documents where HyperWais stores some WAIS document files. 
  24.  
  25. - A folder called wais-questions which does nothing at this time. 
  26.  
  27. - Dont forget to read the release notes located in the Release Notes folder.
  28.  
  29.  
  30. Other software you need:
  31.  
  32. To run HyperWais you will need system 7.0 and Hypercard 2.1.
  33. Hypercard will have to be allocated 1500K of memory, this is 
  34. done using the "Get Info" menu in the Finder.
  35.  
  36.  
  37. Starting up:
  38.  
  39. To start up you need to start the "Wais Listener" application, then start HyperWais. HyperWais will need the wais-sources folder and the wais-documents folder in the folder it is located in (this is in the archive and should be created automatically). Currently HyperWais understands TEXT, WSRC and PICT document types 
  40. but more document types can be added really easily.
  41. Note that the "Wais Listener" needs MacTCP to communicate with wais sources.
  42. You may want to place the "Wais Listener" in the startup folder located in the system folder. This will ensure that the "wais listener" is started up everytime you start up your mac.
  43.  
  44.  
  45. Some limitations:
  46.  
  47. The "Wais Listener" will support any number of connections,
  48. any numbe of open sources per connection, and number of 
  49. document headlines per connection and any number of 
  50. relevance feedback entries per connection. The main limitation
  51. at this point is the amount of memory available to the "Wais
  52. Listener'. 
  53. The connections can open simultaneously either by clients 
  54. located on the same mac as the "Wais Listener" or on a 
  55. different macintosh. This feature would enable you to set up a 
  56. "Wais Listener" gateway on one macintosh with a connection
  57. to the Internet and have a number of other macintoshs using
  58. apple talk to connect up to that Wais Listener.
  59.  
  60.  
  61. Big Disclaimer:
  62.  
  63. This software is now pretty stable at this point and I have
  64. stress tested it a lot and it has not given me any problems.  
  65.  
  66. The Hypercard stack is not the best interface, but it serves as a good example with sample scripts, etc. I would hope that people develop their own stacks, the beauty of this is that you can!.
  67. Note that most the routines you would need to create a new stack are in the stack script. A couple of handlers which parse source 
  68. files and add them to the 
  69.  
  70. Also there are portions of the stack that could be speeded up such as the parsing of source files and storing of document files. I decided to hold out on those until the WAIS API becomes available.
  71.  
  72.  
  73. Other Stuff:
  74.  
  75. The are in fact three components to the HyperWais software:
  76.  
  77. - There are a set of C routines which handle the MacTCP communications and the WAIS protocols. These can be linked in with any other applications which want to use WAIS.
  78.  
  79. - On top of the C routines, there is the module that handle the Apple Events and maps them to the C routines.
  80.  
  81. - There is also another Apple Event module which deals with the communication between the client program and the wais-listener.
  82.  
  83. All these modules are written using Think C 5.0.3. The source code is available for those which want it. I have used a standard 
  84. release of Think C (it will compile with no problems on 
  85. version 5.0.1, 5.0.2 and 5.0.3 of Think C) with no modifications
  86. to the libraries.
  87.  
  88. I would be happy to hear from the people who use this software,
  89. how they are using it and what they are doing with it.
  90.  
  91.  
  92. francois
  93. francois@welchgate.welch.jhu.edu